<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <title> ScriptDoc Reference</title>
        <link rel="stylesheet" href="images/shared.css" type="text/css">
    </head>
    <body>
<h1> GridDefaul Reference</h1>
<div class="content">
  <h2>Properties</h2>
  <div class="list">
  </div>
  <h2>Functions</h2>
  <div class="list">
      <a name="#.addRow"></a> 
      <h3>addRow(<i>Object</i>&nbsp record,<i>Boolean</i>&nbsp startEdit)</h3>
      <p class="padded"> To append a new row.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>record</b></td><td width="80%"> Data of the row to be added.</td></tr><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>startEdit</b></td><td width="80%"> Indicate if open the first cell for input.</td></tr></table></p>
      <a name="#.deleteRow"></a> 
      <h3>deleteRow(<i>Object</i>&nbsp row)</h3>
      <p class="padded"> To remove row.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>row</b></td><td width="80%"> DOM TR presenting a row.</td></tr></table></p>
      <a name="#.selectRow"></a> 
      <h3>selectRow(<i>Object</i>&nbsp row,<i>Object</i>&nbsp selecte)</h3>
      <p class="padded"> To remove row.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>row</b></td><td width="80%"> DOM TR presenting a row.</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>selecte</b></td><td width="80%">d</td></tr></table></p>
      <a name="#.addParameters"></a> 
      <h3>addParameters(<i>String</i>&nbsp key,<i>String</i>&nbsp value)</h3>
      <p class="padded"> To add an additional parameter pair for submittal. By default, only data defined here will be submitted to server side. By this function, developers could add more parameter pairs.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>String</i></td><td width="10%"><b>key</b></td><td width="80%">. Parameter key.</td></tr><tr><td width="10%"><i>String</i></td><td width="10%"><b>value</b></td><td width="80%">. Parameter value.</td></tr></table></p>
      <a name="#.cleanContent"></a> 
      <h3>cleanContent()</h3>
      <p class="padded"> To clear all the data showed and make grid empty.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.cleanParameters"></a> 
      <h3>cleanParameters()</h3>
      <p class="padded"> Remove all additional parameters.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.closeGridMenu"></a> 
      <h3>closeGridMenu()</h3>
      <p class="padded"> To Close main menu.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.endEdit"></a> 
      <h3>endEdit()</h3>
      <p class="padded"> To close current cell editor and update current cell value.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.exportGrid"></a> 
      <h3>exportGrid(<i>Object</i>&nbsp type,<i>Object</i>&nbsp fileNam,<i>Object</i>&nbsp ur,<i>Object</i>&nbsp nam,<i>Object</i>&nbsp actio)</h3>
      <p class="padded"> To export grid to a file. This function need server side programming supported.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>type</b></td><td width="80%">. Export file type. Could be "xls" for MS Excel file, "pdf" for Adobe PDF file, "csv" for</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>fileNam</b></td><td width="80%">e</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>ur</b></td><td width="80%">l</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>nam</b></td><td width="80%">e</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>actio</b></td><td width="80%">n</td></tr></table></p>
      <a name="#.getColumn"></a> 
      <h3>getColumn(<i>Object</i>&nbsp colNoIdTd)</h3>
      <p class="padded"> Get column object by column id or DOM object of cell.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>colNoIdTd</b></td><td width="80%">. Column id or DOM object of cell.</td></tr></table></p>
      <a name="#.getColumnValue"></a> 
      <h3>getColumnValue(<i>String</i>&nbsp colNoIdTd,<i>Integer</i>&nbsp recordOrRowNo)</h3>
      <p class="padded"> Get cell value by specifying column id and row number.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>String</i></td><td width="10%"><b>colNoIdTd</b></td><td width="80%"> Id of column where cell is in.</td></tr><tr><td width="10%"><i>Integer</i></td><td width="10%"><b>recordOrRowNo</b></td><td width="80%">  Number of row where cell is at.</td></tr></table></p>
      <a name="#.getDeletedRecords"></a> 
      <h3>getDeletedRecords()</h3>
      <p class="padded"> To get all records deleted.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.getDisplayColumns"></a> 
      <h3>getDisplayColumns(<i>Boolean</i>&nbsp display)</h3>
      <p class="padded"> To get columns displayed or invisible.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>display</b></td><td width="80%"> visible or invisible.</td></tr></table></p>
      <a name="#.getEventTargets"></a> 
      <h3>getEventTargets(<i>Object</i>&nbsp event,<i>Object</i>&nbsp el)</h3>
      <p class="padded"> To get event relevant info.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>event</b></td><td width="80%"> Sigma.Grid.Event object. See Sigma.Grid.Event</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>el</b></td><td width="80%"> Sigma.Grid.EventTarget object. See Sigma.Grid.EventTarget</td></tr></table></p>
      <a name="#.getInsertedRecords"></a> 
      <h3>getInsertedRecords()</h3>
      <p class="padded"> To get all records deleted.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.getRecord"></a> 
      <h3>getRecord(<i>Object</i>&nbsp rowNoTdTr)</h3>
      <p class="padded"> Get record by row number or DOM of td or tr.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>rowNoTdTr</b></td><td width="80%"> Row number or DOM of td or tr.</td></tr></table></p>
      <a name="#.getSelectedRecords"></a> 
      <h3>getSelectedRecords()</h3>
      <p class="padded"> To get selected records.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.getUpdatedRecords"></a> 
      <h3>getUpdatedRecords()</h3>
      <p class="padded"> To get all records updated.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.hideCellToolTip"></a> 
      <h3>hideCellToolTip()</h3>
      <p class="padded"> To hide tool tip for cell.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.hideDialog"></a> 
      <h3>hideDialog()</h3>
      <p class="padded"> To hide current active dialog.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.hideMask"></a> 
      <h3>hideMask()</h3>
      <p class="padded"> To hide mask.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.insert"></a> 
      <h3>insert(<i>Array</i>&nbsp record,<i>Boolean</i>&nbsp startEdit)</h3>
      <p class="padded"> To insert a row into grid.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Array</i></td><td width="10%"><b>record</b></td><td width="80%"> Array of array/object. Data of row to be inserted. defaultRecord will be adopted if this parameter is null. See Sigma.Grid.defaultRecord</td></tr><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>startEdit</b></td><td width="80%"> To set true to start to edit row right after inserting.</td></tr></table></p>
      <a name="#.printGrid"></a> 
      <h3>printGrid()</h3>
      <p class="padded"> To print grid. This function will popup a printer-choosing dialog box.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.refresh"></a> 
      <h3>refresh(<i>Object</i>&nbsp data)</h3>
      <p class="padded"> To rebuild grid without data reloaded.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>data</b></td><td width="80%"> New content data.</td></tr></table></p>
      <a name="#.reload"></a> 
      <h3>reload(<i>Boolean</i>&nbsp recoun,<i>Boolean</i>&nbsp forc)</h3>
      <p class="padded"> To reload data from server side.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>recoun</b></td><td width="80%">t</td></tr><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>forc</b></td><td width="80%">e</td></tr></table></p>
      <a name="#.render"></a> 
      <h3>render(<i>Object</i>&nbsp container)</h3>
      <p class="padded"> To render a grid.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>container</b></td><td width="80%"> The parent div or something</td></tr></table></p>
      <a name="#.save"></a> 
      <h3>save(<i>Object</i>&nbsp onNa)</h3>
      <p class="padded"> To save modifications to server side.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>onNa</b></td><td width="80%">v</td></tr></table></p>
      <a name="#.setColumnValue"></a> 
      <h3>setColumnValue(<i>String</i>&nbsp colID,<i>Integer</i>&nbsp recordOrRowNo,<i>Object</i>&nbsp newValue)</h3>
      <p class="padded"> Set cell value by specifying column id and row number.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>String</i></td><td width="10%"><b>colID</b></td><td width="80%"> Id of column where cell is in.</td></tr><tr><td width="10%"><i>Integer</i></td><td width="10%"><b>recordOrRowNo</b></td><td width="80%"> Number of row where cell is at.</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>newValue</b></td><td width="80%"> New cell value.</td></tr></table></p>
      <a name="#.setContent"></a> 
      <h3>setContent(<i>Array</i>&nbsp respD)</h3>
      <p class="padded"> To set grid data.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Array</i></td><td width="10%"><b>respD</b></td><td width="80%"> Array of array/object. Data records.</td></tr></table></p>
      <a name="#.showDialog"></a> 
      <h3>showDialog(<i>String</i>&nbsp type)</h3>
      <p class="padded"> To show a dialog.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>String</i></td><td width="10%"><b>type</b></td><td width="80%"> Could be 'filter' or 'chart'.</td></tr></table></p>
      <a name="#.showMask"></a> 
      <h3>showMask(<i>Object</i>&nbsp tr)</h3>
      <p class="padded"> To show a mask.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>tr</b></td><td width="80%">p</td></tr></table></p>
      <a name="#.showWaiting"></a> 
      <h3>showWaiting()</h3>
      <p class="padded"> To show a waiting bar.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.hideWaiting"></a> 
      <h3>hideWaiting()</h3>
      <p class="padded"> To hide a waiting bar.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.getFilterInfo"></a> 
      <h3>getFilterInfo()</h3>
      <p class="padded"> Get filter criteria info</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.setFilterInfo"></a> 
      <h3>setFilterInfo(<i>Object</i>&nbsp f)</h3>
      <p class="padded"> To set filter info.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>f</b></td><td width="80%">i</td></tr></table></p>
      <a name="#.applyFilter"></a> 
      <h3>applyFilter(<i>Object</i>&nbsp filterInfo)</h3>
      <p class="padded"> Apply filter to this grid.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>filterInfo</b></td><td width="80%">. Filter criteria.</td></tr></table></p>
      <a name="#.setDimension"></a> 
      <h3>setDimension(<i>Object</i>&nbsp newWidth,<i>Object</i>&nbsp newHeight,<i>Object</i>&nbsp isIni)</h3>
      <p class="padded"> To set grid width and height.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>newWidth</b></td><td width="80%"> New width.</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>newHeight</b></td><td width="80%"> New height.</td></tr><tr><td width="10%"><i>Object</i></td><td width="10%"><b>isIni</b></td><td width="80%">t</td></tr></table></p>
      <a name="#.getDimension"></a> 
      <h3>getDimension()</h3>
      <p class="padded"> To get grid width and height.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.getSkin"></a> 
      <h3>getSkin()</h3>
      <p class="padded"> To get skin name</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"></table></p>
      <a name="#.setSkin"></a> 
      <h3>setSkin(<i>String</i>&nbsp skin)</h3>
      <p class="padded"> To change skin by name</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>String</i></td><td width="10%"><b>skin</b></td><td width="80%"> Skin name. Could be 'default', 'mac', 'vista' and 'pink'.</td></tr></table></p>
      <a name="#.getPageInfo"></a> 
      <h3>getPageInfo(<i>Object</i>&nbsp refresh)</h3>
      <p class="padded"> To get pagging info.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>refresh</b></td><td width="80%"> Indecate to refresh navigator tool bar or not.</td></tr></table></p>
      <a name="#.setPageInfo"></a> 
      <h3>setPageInfo(<i>Object</i>&nbsp pageInf)</h3>
      <p class="padded"> To update pagingo info.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Object</i></td><td width="10%"><b>pageInf</b></td><td width="80%">o</td></tr></table></p>
      <a name="#.gotoPage"></a> 
      <h3>gotoPage(<i>Number</i>&nbsp pageId)</h3>
      <p class="padded"> To go to page pageIdx</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Number</i></td><td width="10%"><b>pageId</b></td><td width="80%">x</td></tr></table></p>
      <a name="#.forEachRow"></a> 
      <h3>forEachRow(<i>Function</i>&nbsp fn)</h3>
      <p class="padded"> Excute function fn(row,record,i,grid) on each row.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Function</i></td><td width="10%"><b>fn</b></td><td width="80%"> row: The object of the row. record: The data record behine the row. i: Loop counter. grid: Grid object.</td></tr></table></p>
      <a name="#.moveColumn"></a> 
      <h3>moveColumn(<i>Integer</i>&nbsp oldIndex,<i>Integer</i>&nbsp newIndex,<i>Boolean</i>&nbsp ifreeze)</h3>
      <p class="padded"> To move column oldIndex to new Index.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Integer</i></td><td width="10%"><b>oldIndex</b></td><td width="80%"> Index of column to be moved.</td></tr><tr><td width="10%"><i>Integer</i></td><td width="10%"><b>newIndex</b></td><td width="80%"> Index of new position.</td></tr><tr><td width="10%"><i>Boolean</i></td><td width="10%"><b>ifreeze</b></td><td width="80%"> Whether to freeze it.</td></tr></table></p>
      <a name="#.sortGrid"></a> 
      <h3>sortGrid(<i>Array</i>&nbsp sortInfo)</h3>
      <p class="padded"> To sort grid by specifed rules.</p>
      <p class="padded"><table cellspacing="3" width="90%" class="parameter-table"><tr><td width="10%"><i>Array</i></td><td width="10%"><b>sortInfo</b></td><td width="80%">. Array of sortInfo.</td></tr></table></p>
  </div>
</div>        
    </body>
</html>
